package cn.fornever.dbdoc.entity.apidoc;

public class ApiDocDemo {


    /**
     * @apiDeprecated use now (#Group:Name).
     * @api {get} /user/:id Users unique ID.
     * @apiName GetUser
     * @apiVersion 1.6.2
     * @apiDescription This is the Description.
     * It is multiline capable.
     * Last line of Description.
     * @apiGroup User
     *
     * @apiHeader {String} access-key Users unique access-key.
     * @apiHeaderExample {json} Header-Example:
     * {
     * "Accept-Encoding": "Accept-Encoding: gzip, deflate"
     * }
     * @apiParam {String} [firstname]  Optional Firstname of the User.
     * @apiParam {String} lastname     Mandatory Lastname.
     * @apiParam {String} country="DE" Mandatory with default value "DE".
     * @apiParam {Number} [age=18]     Optional Age with default 18.
     * @apiParam (Login) {String} pass Only logged in users can post this.In generated documentation a separate."Login" Block will be generated.
     * @apiParamExample {json} Request-Example:
     * {
     * "id": 4711
     * }
     * @apiSuccess {Object[]} profiles       List of user profiles.
     * @apiSuccess {Number}   profiles.age   Users age.
     * @apiSuccess {String}   profiles.image Avatar-Image.
     * @apiSuccessExample {json} Success-Response:
     * HTTP/1.1 200 OK
     * {
     * "firstname": "John",
     * "lastname": "Doe"
     * }
     * @apiSampleRequest /test
     * @apiExample {curl} Example usage:
     * curl -i http://localhost/user/4711
     * @apiUse MyError
     * @apiError UserNotFound11 The <code>id</code> of the User was not found.
     * @apiErrorExample {json} Error-Response:
     * HTTP/1.1 404 Not Found
     * {
     * "error": "UserNotFound11"
     * }
     * @apiPermission none
     * @apiPrivate
     */
    public static void main(String[] args) {

    }
}
